/*! \file ser_intr_dispatch.c
 *
 * Interface functions for SER interrupt dispatching messages
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

/******************************************************************************
 * Includes
 */
#include <sal/sal_msgq.h>
#include <shr/shr_debug.h>
#include <bcmdrd_config.h>
#include <shr/shr_error.h>
#include "bcmdrd/bcmdrd_pt.h"
#include <sal/sal_sleep.h>
#include <bcmptm/bcmptm_ser_chip_internal.h>
#include <bcmptm/bcmptm_ser_cth_internal.h>
#include <bcmptm/bcmptm_ser_internal.h>

#include "ser_intr_dispatch.h"
#include "ser_config.h"
 /******************************************************************************
 * Defines
 */
#define  BSL_LOG_MODULE  BSL_LS_BCMPTM_SER

/******************************************************************************
 * Typedefs
 */


/******************************************************************************
 * Private variables
 */

/*!
 * \brief interrupt dispatching messages queue (per unit)
 */
static sal_msgq_t intr_dispatch_msg_q[BCMDRD_CONFIG_MAX_UNITS];

/******************************************************************************
 * Private Functions
 */


/******************************************************************************
 * bcmptm_ser_msg_recieve
 */
static void
bcmptm_ser_msg_post(int unit, uint32_t intr_num, bcmptm_ser_intr_msg_q_info_t *ser_msg)
{
    int rv = SHR_E_NONE;

    if (intr_num != 0) {
        BCMPTM_SER_DATA_DRIVER_CB(unit, cmic_intr_enable_fn)
            (unit, 0, ser_msg->reg_id, ser_msg->bit_offset, 0);
        LOG_ERROR(BSL_LOG_MODULE,
                  (BSL_META_U(unit,
                              "Receive intr from unit [%d] reg_id [%d] bit_offset [%d]\n"),
                   ser_msg->unit, ser_msg->reg_id, ser_msg->bit_offset));
    }

    if (intr_dispatch_msg_q[unit] == NULL) {
        LOG_WARN(BSL_LOG_MODULE,
                 (BSL_META_U(unit,
                             "Interrupt dispatch message queue is not created\n")));
        return;
    }
    rv = sal_msgq_post(intr_dispatch_msg_q[unit],
                       (void *)ser_msg,
                       SAL_MSGQ_NORMAL_PRIORITY,
                       SAL_MSGQ_NOWAIT);

    /* If the message is not posted successfully, needs to re-enable interrupt */
    if (rv != SHR_E_NONE) {
        LOG_WARN(BSL_LOG_MODULE,
                 (BSL_META_U(unit,
                             "Interrupt dispatch message queue is full"
                             " SERC thread may not correct ser error in time\n")));
        if (intr_num != 0) {
            BCMPTM_SER_DATA_DRIVER_CB(unit, cmic_intr_enable_fn)
                (unit, 0, ser_msg->reg_id, ser_msg->bit_offset, 1);
        }
    }
}

 /******************************************************************************
 * Public Functions
 */
/******************************************************************************
 * bcmptm_ser_intr_msg_q_destroy
 */
void
bcmptm_ser_intr_msg_q_destroy(int unit)
{
    if (intr_dispatch_msg_q[unit] != NULL) {
        sal_msgq_destroy(intr_dispatch_msg_q[unit]);
        intr_dispatch_msg_q[unit] = NULL;
    }
}

/******************************************************************************
 * bcmptm_ser_intr_msg_q_create
 */
int
bcmptm_ser_intr_msg_q_create(int unit)
{
    int rv = SHR_E_NONE;
    uint32_t intr_msg_q_depth = 0;

    SHR_FUNC_ENTER(unit);

    intr_msg_q_depth = BCMPTM_SER_CTH_CB(ser_msg_q_depth_get)(unit);

    if (intr_msg_q_depth == 0) {
        LOG_WARN(BSL_LOG_MODULE,
                 (BSL_META_U(unit,
                             "intr_msg_q_depth(0) is invalid\n")));
        SHR_RETURN_VAL_EXIT(SHR_E_PARAM);
    }

    if (intr_dispatch_msg_q[unit] == NULL) {
        intr_dispatch_msg_q[unit] =
            sal_msgq_create(sizeof(bcmptm_ser_intr_msg_q_info_t),
                            intr_msg_q_depth, "intr dispatch message queue");

        rv = (intr_dispatch_msg_q[unit] == NULL) ? SHR_E_FAIL : SHR_E_NONE;
        if (SHR_FAILURE(rv)) {
            LOG_WARN(BSL_LOG_MODULE,
                     (BSL_META_U(unit,
                                 "Fail to create intr message queue(depth %d)\n"),
                      intr_msg_q_depth));
        }
    } else {
        /*
                * If msg queue is re-created,
                * some messages in old queue may lost.
                * In order to avoid the above situation, the old msg queue is always used.
                */
    }
    SHR_RETURN_VAL_EXIT(rv);

exit:
    SHR_FUNC_EXIT();
}

/******************************************************************************
 * bcmptm_ser_mmu_notify
 */
void
bcmptm_ser_mmu_notify(int unit, uint32_t intr_param)
{
    bcmptm_ser_mmu_intr_mapping_t *ser_mmu_intr_map = NULL;
    uint32_t cmic_intr_id = 0;
    int intr_map_num = 0;
    bcmptm_ser_intr_msg_q_info_t ser_msg;

    (void)BCMPTM_SER_DATA_DRIVER_CB(unit, mmu_intr_map_get_fn)
        (unit, &cmic_intr_id, &ser_mmu_intr_map, &intr_map_num);

    ser_msg.unit = unit;
    ser_msg.reg_id = cmic_intr_id / 32;
    ser_msg.bit_offset = cmic_intr_id % 32;
    ser_msg.intr_param = intr_param;

    bcmptm_ser_msg_post(unit, cmic_intr_id, &ser_msg);
}

/******************************************************************************
 * bcmptm_ser_notify
 */
void
bcmptm_ser_notify(int unit, uint32_t intr_num)
{
    bcmptm_ser_intr_msg_q_info_t ser_msg;

    ser_msg.unit = unit;
    ser_msg.reg_id = intr_num / 32;
    ser_msg.bit_offset = intr_num % 32;
    ser_msg.intr_param = 0;

    bcmptm_ser_msg_post(unit, intr_num, &ser_msg);
}

/******************************************************************************
 * bcmptm_ser_msg_recieve
 */
int
bcmptm_ser_msg_recieve(int unit, bcmptm_ser_intr_msg_q_info_t *ser_msg,
                       uint32_t usec)
{
    return sal_msgq_recv(intr_dispatch_msg_q[unit], (void *)ser_msg, usec);
}

/******************************************************************************
 * bcmptm_ser_msg_count
 */
size_t
bcmptm_ser_msg_count(int unit)
{
    return sal_msgq_count_get(intr_dispatch_msg_q[unit]);
}

